/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.core.api;

import org.proteusframework.core.api.model.IVersion;

/**
 * Simple emitter used when Proteus is invoked via command line to generate stubbed out interfaces for a given target.
 */
public interface IInterfaceEmitter
{
    /**
     * Identifies the version of interface being emitted.
     *
     * @return Version
     */
    IVersion getVersion();

    /**
     * Emits the version of the identified interface.
     *
     * @param packageName   Target package name
     * @param interfaceName Target interface name
     * @return String represented the emitted interface
     */
    String emit(String packageName, String interfaceName);

    /**
     * List of methods declared by the given interface version.
     *
     * @return String representation of the complete list of interface methods
     */
    String listMethods();
}
